Skip to content

docs: improve --help text for --start-group and --end-group - #1753

Open
Vedant Madane (VedantMadane) wants to merge 1 commit into
qualcomm:mainfrom
VedantMadane:docs/start-end-group-help
Open

docs: improve --help text for --start-group and --end-group#1753
Vedant Madane (VedantMadane) wants to merge 1 commit into
qualcomm:mainfrom
VedantMadane:docs/start-end-group-help

Conversation

@VedantMadane

Copy link
Copy Markdown

Summary

Expand --help strings for --start-group / --end-group (and short aliases) to explain that archives in the group are searched iteratively until no new undefined symbols are resolved.

Test plan

  • HelpText-only change in GnuLinkerOptions.td

Fixes #1743

Explain that archives in a group are searched iteratively until no new
undefined symbols are resolved, matching common ld(1) wording.

Fixes qualcomm#1743

Signed-off-by: Vedant Madane <6527493+VedantMadane@users.noreply.github.com>
Alias<u>;
defm start_group : mDashDeprWithOpt<"start-group", "start_group",
"Start a group">,
"Archives between --start-group and --end-group are searched repeatedly until no new undefined symbols are resolved">,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A new line marker ('\n') would be helpful in the help text here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve --help documentation for --start-group and --end-group

2 participants